pathfinder object

This method cancels the current pathfinding operation.

bool cancel()

Parameters:
None.

Return value:
true on success, false on failure.

Remarks:
If you cancel the current pathfinding operation, the find call will return an array with 0 elements and set the last error flag accordingly.

This method may only be invoked from within the user callback.

Example:
See the main pathfinder chapter and the pathfinding tutorial.